Document gdk_display_get_setting
authorMatthias Clasen <mclasen@redhat.com>
Tue, 26 Dec 2017 15:21:45 +0000 (10:21 -0500)
committerMatthias Clasen <mclasen@redhat.com>
Tue, 26 Dec 2017 16:51:28 +0000 (11:51 -0500)
New api needs documentation.

gdk/gdkdisplay.c

index 1d0319aadaf0402971b1b7801b01e39598548923..f7085d54fd4e7095cafd4fbd8f1fef943f330c7b 100644 (file)
@@ -1901,6 +1901,20 @@ gdk_display_emit_opened (GdkDisplay *display)
   g_signal_emit (display, signals[OPENED], 0);
 }
 
+/**
+ * gdk_display_get_setting:
+ * @display: a #GdkDisplay
+ * @name: the name of the setting
+ * @value: location to store the value of the setting
+ *
+ * Retrieves a desktop-wide setting such as double-click time
+ * for the @display.
+ *
+ * Returns: %TRUE if the setting existed and a value was stored
+ *   in @value, %FALSE otherwise
+ *
+ * Since: 3.94
+ */
 gboolean
 gdk_display_get_setting (GdkDisplay *display,
                          const char *name,